From 7f6a964c47ad2f9dcf6a00044d938840ce8f01f2 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 9 Feb 2014 17:24:06 -0500 Subject: [PATCH] Docs: Remove all entities and turn off sgml mode With all element markup gone, it is time to turn off sgml mode, and get rid of entities as well. --- docs/reference/gdk/Makefile.am | 2 +- docs/reference/gtk/Makefile.am | 2 +- gdk/gdkcolor.c | 18 ++++--- gdk/gdkdevice.c | 4 +- gdk/gdkdevicemanager.c | 2 +- gdk/gdkdisplay.c | 4 +- gdk/gdkkeys.c | 28 +++++------ gdk/gdkrgba.c | 4 +- gdk/gdkscreen.c | 4 +- gdk/wayland/gdkdisplay-wayland.c | 7 ++- gdk/x11/gdkmain-x11.c | 7 ++- gtk/deprecated/gtkactiongroup.c | 32 ++++++------- gtk/deprecated/gtkiconfactory.c | 5 +- gtk/deprecated/gtkrc.c | 81 ++++++++++++++----------------- gtk/deprecated/gtkrecentaction.c | 4 +- gtk/deprecated/gtkuimanager.c | 29 +++++------ gtk/gtkaboutdialog.c | 10 ++-- gtk/gtkaccelgroup.c | 23 +++++---- gtk/gtkaccellabel.c | 16 ++++--- gtk/gtkaccelmap.c | 4 +- gtk/gtkapplication.c | 5 +- gtk/gtkapplicationwindow.c | 21 ++++---- gtk/gtkbindings.c | 29 ++++++----- gtk/gtkbuildable.c | 2 +- gtk/gtkbuilder.c | 82 ++++++++++++++++---------------- gtk/gtkcelllayout.c | 21 ++++---- gtk/gtkcombobox.c | 4 +- gtk/gtkcomboboxtext.c | 15 +++--- gtk/gtkcontainer.c | 7 ++- gtk/gtkcsscustomproperty.c | 2 +- gtk/gtkcssprovider.c | 22 ++++----- gtk/gtkdialog.c | 10 ++-- gtk/gtkdnd-quartz.c | 2 +- gtk/gtkdnd.c | 8 ++-- gtk/gtkdrawingarea.c | 2 +- gtk/gtkexpander.c | 9 ++-- gtk/gtkfilechooser.c | 2 +- gtk/gtkfilechooserbutton.c | 2 +- gtk/gtkfilefilter.c | 9 ++-- gtk/gtkframe.c | 9 ++-- gtk/gtkicontheme.c | 10 ++-- gtk/gtkiconview.c | 4 +- gtk/gtkimage.c | 14 +++--- gtk/gtkinfobar.c | 8 ++-- gtk/gtklabel.c | 25 +++++----- gtk/gtkliststore.c | 27 +++++------ gtk/gtkmenu.c | 6 +-- gtk/gtkmenubutton.c | 1 + gtk/gtkmenuitem.c | 6 +-- gtk/gtkmenutoolbutton.c | 4 +- gtk/gtkmessagedialog.c | 2 +- gtk/gtknotebook.c | 8 ++-- gtk/gtkoverlay.c | 2 +- gtk/gtkpagesetup.c | 2 +- gtk/gtkprinter.c | 6 +-- gtk/gtkprintsettings.c | 4 +- gtk/gtkradiobutton.c | 2 +- gtk/gtkrecentfilter.c | 12 ++--- gtk/gtkrecentmanager.c | 2 +- gtk/gtkscale.c | 14 +++--- gtk/gtkselection.c | 8 ++-- gtk/gtksettings.c | 6 +-- gtk/gtkshow.c | 2 +- gtk/gtksizegroup.c | 11 ++--- gtk/gtksizerequest.c | 10 ++-- gtk/gtksocket.c | 2 +- gtk/gtkstylecontext.c | 6 +-- gtk/gtktextbufferrichtext.c | 8 ++-- gtk/gtktexttagtable.c | 4 +- gtk/gtkthemingengine.c | 2 +- gtk/gtktogglebutton.c | 4 +- gtk/gtktoolbar.c | 8 ++-- gtk/gtktoolbutton.c | 2 +- gtk/gtktoolitem.c | 6 +-- gtk/gtktoolitemgroup.c | 2 +- gtk/gtktoolpalette.c | 10 ++-- gtk/gtktreemodel.c | 8 ++-- gtk/gtktreemodelfilter.c | 2 +- gtk/gtktreemodelsort.c | 28 +++++------ gtk/gtktreeselection.c | 2 +- gtk/gtktreestore.c | 6 +-- gtk/gtktreeview.c | 10 ++-- gtk/gtkwidget.c | 65 +++++++++++++------------ gtk/gtkwidget.h | 2 + gtk/gtkwidgetpath.c | 6 +-- gtk/gtkwindow.c | 13 +++-- 86 files changed, 453 insertions(+), 488 deletions(-) diff --git a/docs/reference/gdk/Makefile.am b/docs/reference/gdk/Makefile.am index 7aefc4d23f..f19ae8cb7d 100644 --- a/docs/reference/gdk/Makefile.am +++ b/docs/reference/gdk/Makefile.am @@ -48,7 +48,7 @@ AM_CPPFLAGS = \ GTKDOC_LIBS = $(top_builddir)/gdk/libgdk-3.la $(GDK_DEP_LIBS) # Extra options to supply to gtkdoc-mkdb -MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=gdk +MKDB_OPTIONS=--output-format=xml --name-space=gdk # Extra SGML files that are included by DOC_MAIN_SGML_FILE content_files = \ diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am index e66e20f48e..d5e0c32d69 100644 --- a/docs/reference/gtk/Makefile.am +++ b/docs/reference/gtk/Makefile.am @@ -126,7 +126,7 @@ GTKDOC_LIBS = \ # Extra options to supply to gtkdoc-mkdb -MKDB_OPTIONS=--sgml-mode --output-format=xml --name-space=gtk +MKDB_OPTIONS=--output-format=xml --name-space=gtk # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE) content_files = \ diff --git a/gdk/gdkcolor.c b/gdk/gdkcolor.c index e93c82a840..c121593869 100644 --- a/gdk/gdkcolor.c +++ b/gdk/gdkcolor.c @@ -131,13 +131,12 @@ G_DEFINE_BOXED_TYPE (GdkColor, gdk_color, * @red, @green, and @blue fields of a #GdkColor. * * The string can either one of a large set of standard names - * (taken from the X11 `rgb.txt` file), or - * it can be a hex value in the form “#rgb” “#rrggbb” - * “#rrrgggbbb” or “#rrrrggggbbbb” where “r”, “g” and - * “b” are hex digits of the red, green, and blue components - * of the color, respectively. (White in the four forms is - * “#fff”, “#ffffff”, “#fffffffff” and - * “#ffffffffffff”). + * (taken from the X11 `rgb.txt` file), or it can be a hexadecimal + * value in the form “\#rgb” “\#rrggbb”, “\#rrrgggbbb” or + * “\#rrrrggggbbbb” where “r”, “g” and “b” are hex digits of + * the red, green, and blue components of the color, respectively. + * (White in the four forms is “\#fff”, “\#ffffff”, “\#fffffffff” + * and “\#ffffffffffff”). * * Return value: %TRUE if the parsing succeeded */ @@ -163,9 +162,8 @@ gdk_color_parse (const gchar *spec, * gdk_color_to_string: * @color: a #GdkColor * - * Returns a textual specification of @color in the hexadecimal form - * `#rrrrggggbbbb`, where `r`, - * `g` and `b` are hex digits + * Returns a textual specification of @color in the hexadecimal + * form `\#rrrrggggbbbb`, where `r`, `g` and `b` are hex digits * representing the red, green and blue components respectively. * * The returned string can be parsed by gdk_color_parse(). diff --git a/gdk/gdkdevice.c b/gdk/gdkdevice.c index 1660923e1d..653a0aa2f9 100644 --- a/gdk/gdkdevice.c +++ b/gdk/gdkdevice.c @@ -1084,11 +1084,11 @@ gdk_device_get_n_axes (GdkDevice *device) * gdk_device_list_axes: * @device: a pointer #GdkDevice * - * Returns a #GList of #GdkAtoms, containing the labels for + * Returns a #GList of #GdkAtoms, containing the labels for * the axes that @device currently has. * * Returns: (transfer container) (element-type GdkAtom): - * A #GList of #GdkAtoms, free with g_list_free(). + * A #GList of #GdkAtoms, free with g_list_free(). * * Since: 3.0 **/ diff --git a/gdk/gdkdevicemanager.c b/gdk/gdkdevicemanager.c index e9f96793a6..a056b7a323 100644 --- a/gdk/gdkdevicemanager.c +++ b/gdk/gdkdevicemanager.c @@ -307,7 +307,7 @@ gdk_device_manager_get_display (GdkDeviceManager *device_manager) * @device_manager. * * Returns: (transfer container) (element-type Gdk.Device): a list of - * #GdkDevices. The returned list must be + * #GdkDevices. The returned list must be * freed with g_list_free (). The list elements are owned by * GTK+ and must not be freed or unreffed. * diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c index 2fd423fa6e..6896197f9d 100644 --- a/gdk/gdkdisplay.c +++ b/gdk/gdkdisplay.c @@ -2110,12 +2110,12 @@ static GQueue gdk_error_traps = G_QUEUE_INIT; * ## Trapping an X error * * |[ - * gdk_error_trap_push (); + * gdk_error_trap_push (); * * // ... Call the X function which may cause an error here ... * * - * if (gdk_error_trap_pop ()) + * if (gdk_error_trap_pop ()) * { * // ... Handle the error here ... * } diff --git a/gdk/gdkkeys.c b/gdk/gdkkeys.c index 63e92bfc87..468241f096 100644 --- a/gdk/gdkkeys.c +++ b/gdk/gdkkeys.c @@ -495,12 +495,10 @@ gdk_keymap_lookup_key (GdkKeymap *keymap, * @state. For convenience, #GdkEventKey already contains the translated * keyval, so this function isn’t as useful as you might think. * - * @consumed_modifiers gives modifiers that should be masked out - * from @state when comparing this key press to a hot key. For - * instance, on a US keyboard, the `plus` - * symbol is shifted, so when comparing a key press to a - * `<Control>plus` accelerator <Shift> should - * be masked out. + * @consumed_modifiers gives modifiers that should be masked outfrom @state + * when comparing this key press to a hot key. For instance, on a US keyboard, + * the `plus` symbol is shifted, so when comparing a key press to a + * `plus` accelerator `` should be masked out. * * |[ * /* We want to ignore irrelevant modifiers like ScrollLock */; @@ -525,16 +523,14 @@ gdk_keymap_lookup_key (GdkKeymap *keymap, * ]| * * However, this did not work if multi-modifier combinations were - * used in the keymap, since, for instance, `<Control>` - * would be masked out even if only `<Control><Alt>` - * was used in the keymap. To support this usage as well as well as - * possible, all single modifier combinations - * that could affect the key for any combination of modifiers will - * be returned in @consumed_modifiers; multi-modifier combinations - * are returned only when actually found in @state. When you store - * accelerators, you should always store them with consumed modifiers - * removed. Store `<Control>plus`, - * not `<Control><Shift>plus`, + * used in the keymap, since, for instance, `` would be + * masked out even if only `` was used in the keymap. + * To support this usage as well as well as possible, all single + * modifier combinations that could affect the key for any combination + * of modifiers will be returned in @consumed_modifiers; multi-modifier + * combinations are returned only when actually found in @state. When + * you store accelerators, you should always store them with consumed + * modifiers removed. Store `plus`, not `plus`, * * Return value: %TRUE if there was a keyval bound to the keycode/state/group **/ diff --git a/gdk/gdkrgba.c b/gdk/gdkrgba.c index d48472e189..5f65d1574c 100644 --- a/gdk/gdkrgba.c +++ b/gdk/gdkrgba.c @@ -142,8 +142,8 @@ parse_rgb_value (const gchar *str, * * The string can be either one of: * - A standard name (Taken from the X11 rgb.txt file). - * - A hex value in the form “#rgb” “#rrggbb” “#rrrgggbbb” - * or “#rrrrggggbbbb” + * - A hexadecimal value in the form “\#rgb”, “\#rrggbb”, + * “\#rrrgggbbb” or ”\#rrrrggggbbbb” * - A RGB color in the form “rgb(r,g,b)” (In this case the color will * have full opacity) * - A RGBA color in the form “rgba(r,g,b,a)” diff --git a/gdk/gdkscreen.c b/gdk/gdkscreen.c index 2e25af7def..fef85cd907 100644 --- a/gdk/gdkscreen.c +++ b/gdk/gdkscreen.c @@ -1020,7 +1020,7 @@ gdk_screen_get_active_window (GdkScreen *screen) * gdk_screen_get_window_stack: * @screen: a #GdkScreen * - * Returns a #GList of #GdkWindows representing the current + * Returns a #GList of #GdkWindows representing the current * window stack. * * On X11, this is done by inspecting the _NET_CLIENT_LIST_STACKING @@ -1037,7 +1037,7 @@ gdk_screen_get_active_window (GdkScreen *screen) * its windows unrefed using g_object_unref() when no longer needed. * * Return value: (transfer full) (element-type GdkWindow): - * a list of #GdkWindows for the current window stack, + * a list of #GdkWindows for the current window stack, * or %NULL. * * Since: 2.10 diff --git a/gdk/wayland/gdkdisplay-wayland.c b/gdk/wayland/gdkdisplay-wayland.c index 4859877a2d..c1af8b24bc 100644 --- a/gdk/wayland/gdkdisplay-wayland.c +++ b/gdk/wayland/gdkdisplay-wayland.c @@ -40,10 +40,9 @@ * @Title: Wayland Interaction * * The functions in this section are specific to the GDK Wayland backend. - * To use them, you need to include the `<gdk/gdkwayland.h>` - * header and use the Wayland-specific pkg-config files to build your - * application (either `gdk-wayland-3.0` or - * `gtk+-wayland-3.0`). + * To use them, you need to include the `` header and use + * the Wayland-specific pkg-config files to build your application (either + * `gdk-wayland-3.0` or `gtk+-wayland-3.0`). * * To make your code compile with other GDK backends, guard backend-specific * calls by an ifdef as follows. Since GDK may be built with multiple diff --git a/gdk/x11/gdkmain-x11.c b/gdk/x11/gdkmain-x11.c index 6447eb1d9d..5f51d1e0b0 100644 --- a/gdk/x11/gdkmain-x11.c +++ b/gdk/x11/gdkmain-x11.c @@ -52,10 +52,9 @@ * @Title: X Window System Interaction * * The functions in this section are specific to the GDK X11 backend. - * To use them, you need to include the `<gdk/gdkx.h>` - * header and use the X11-specific pkg-config files to build your - * application (either `gdk-x11-3.0` or - * `gtk+-x11-3.0`). + * To use them, you need to include the `` header and use + * the X11-specific pkg-config files to build your application (either + * `gdk-x11-3.0` or `gtk+-x11-3.0`). * * To make your code compile with other GDK backends, guard backend-specific * calls by an ifdef as follows. Since GDK may be built with multiple diff --git a/gtk/deprecated/gtkactiongroup.c b/gtk/deprecated/gtkactiongroup.c index e68f6d583e..44bc6d5b22 100644 --- a/gtk/deprecated/gtkactiongroup.c +++ b/gtk/deprecated/gtkactiongroup.c @@ -48,24 +48,23 @@ * * Accelerators are handled by the GTK+ accelerator map. All actions are * assigned an accelerator path (which normally has the form - * `<Actions>/group-name/action-name`) - * and a shortcut is associated with this accelerator path. All menuitems - * and toolitems take on this accelerator path. The GTK+ accelerator map - * code makes sure that the correct shortcut is displayed next to the menu - * item. + * `/group-name/action-name`) and a shortcut is associated with + * this accelerator path. All menuitems and toolitems take on this accelerator + * path. The GTK+ accelerator map code makes sure that the correct shortcut + * is displayed next to the menu item. * * # GtkActionGroup as GtkBuildable # {#GtkActionGroup-BUILDER-UI} * * The #GtkActionGroup implementation of the #GtkBuildable interface accepts - * #GtkAction objects as <child> elements in UI definitions. + * #GtkAction objects as elements in UI definitions. * * Note that it is probably more common to define actions and action groups * in the code, since they are directly related to what the code can do. * * The GtkActionGroup implementation of the GtkBuildable interface supports - * a custom <accelerator> element, which has attributes named key and - * modifiers and allows to specify accelerators. This is similar to the - * <accelerator> element of #GtkWidget, the main difference is that + * a custom element, which has attributes named “key“ and + * “modifiers“ and allows to specify accelerators. This is similar to the + * element of #GtkWidget, the main difference is that * it doesn’t allow you to specify a signal. * * ## A #GtkDialog UI definition fragment. ## @@ -964,8 +963,7 @@ gtk_action_group_add_action (GtkActionGroup *action_group, * If @accelerator is %NULL, attempts to use the accelerator associated * with the stock_id of the action. * - * Accel paths are set to - * `<Actions>/group-name/action-name`. + * Accel paths are set to `/group-name/action-name`. * * Since: 2.4 * @@ -1108,9 +1106,8 @@ gtk_action_group_list_actions (GtkActionGroup *action_group) * This is a convenience function to create a number of actions and add them * to the action group. * - * The “activate” signals of the actions are connected to the callbacks and - * their accel paths are set to - * `<Actions>/group-name/action-name`. + * The “activate” signals of the actions are connected to the callbacks + * and their accel paths are set to `/group-name/action-name`. * * Since: 2.4 * @@ -1243,9 +1240,8 @@ gtk_action_group_add_actions_full (GtkActionGroup *action_group, * This is a convenience function to create a number of toggle actions and add them * to the action group. * - * The “activate” signals of the actions are connected to the callbacks and - * their accel paths are set to - * `<Actions>/group-name/action-name`. + * The “activate” signals of the actions are connected to the callbacks + * and their accel paths are set to `/group-name/action-name`. * * Since: 2.4 * @@ -1365,7 +1361,7 @@ gtk_action_group_add_toggle_actions_full (GtkActionGroup *action_gro * * The “changed” signal of the first radio action is connected to the * @on_change callback and the accel paths of the actions are set to - * `<Actions>/group-name/action-name`. + * `/group-name/action-name`. * * Since: 2.4 * diff --git a/gtk/deprecated/gtkiconfactory.c b/gtk/deprecated/gtkiconfactory.c index ba5199aa84..4ee94c7541 100644 --- a/gtk/deprecated/gtkiconfactory.c +++ b/gtk/deprecated/gtkiconfactory.c @@ -72,9 +72,8 @@ * * # GtkIconFactory as GtkBuildable # {#GtkIconFactory-BUILDER-UI} * - * GtkIconFactory supports a custom <sources> element, which can contain - * multiple <source> elements. - * The following attributes are allowed: + * GtkIconFactory supports a custom element, which can contain + * multiple elements. The following attributes are allowed: * * - stock-id * diff --git a/gtk/deprecated/gtkrc.c b/gtk/deprecated/gtkrc.c index bb058615f1..4e7a0b7f5a 100644 --- a/gtk/deprecated/gtkrc.c +++ b/gtk/deprecated/gtkrc.c @@ -134,18 +134,18 @@ * the class name of the widget, while for the class path, the class name is * always used. * - * Since GTK+ 2.10, `widget_class` paths can also contain - * `<classname>` substrings, which are matching - * the class with the given name and any derived classes. For instance, + * Since GTK+ 2.10, `widget_class` paths can also contain + * substrings, which are matching the class with the given name and any + * derived classes. For instance, * |[ - * widget_class "*<GtkMenuItem>.GtkLabel" style "my-style" + * widget_class "*.GtkLabel" style "my-style" * ]| * will match #GtkLabel widgets which are contained in any kind of menu item. * - * So, if you have a #GtkEntry named `"myentry"`, inside of a - * horizontal box in a window named `"mywindow"`, then the - * widget path is: `"mywindow.GtkHBox.myentry"` - * while the class path is: `"GtkWindow.GtkHBox.GtkEntry"`. + * So, if you have a #GtkEntry named `"myentry"`, inside of a horizontal + * box in a window named `"mywindow"`, then the widget path is: + * `"mywindow.GtkHBox.myentry"` while the class path is: + * `"GtkWindow.GtkHBox.GtkEntry"`. * * Matching against class is a little different. The pattern match is done * against all class names in the widgets class hierarchy (not the layout @@ -372,12 +372,11 @@ * * `bg_pixmap[state] = * pixmap` * - * Sets a background pixmap to be used in place of - * the `bg` color (or for #GtkText, - * in place of the `base` color. The special - * value `"<parent>"` may be used to indicate that the widget should + * Sets a background pixmap to be used in place of the `bg` color + * (or for #GtkText, in place of the `base` color. The special + * value `""` may be used to indicate that the widget should * use the same background pixmap as its parent. The special value - * `"<none>"` may be used to indicate no background pixmap. + * `""` may be used to indicate no background pixmap. * * `font = font` * @@ -578,54 +577,46 @@ * } * ]| * - * `key` is a string consisting of a - * series of modifiers followed by the name of a key. The - * modifiers can be: + * `key` is a string consisting of a series of modifiers followed by + * the name of a key. The modifiers can be: * - * - `<alt>` + * - `` * - * - `<ctl>` + * - `` * - * - `<control>` + * - `` * - * - `<meta>` + * - `` * - * - `<hyper>` + * - `` * - * - `<super>` + * - `` * - * - `<mod1>` + * - `` * - * - `<mod2>` + * - `` * - * - `<mod3>` + * - `` * - * - `<mod4>` + * - `` * - * - `<mod5>` + * - `` * - * - `<release>` + * - `` * - * - `<shft>` + * - `` * - * - `<shift>` + * - `` * - * `<shft>` is an alias for - * `<shift>`, - * `<ctl>` is an alias for - * `<control>`, - * and - * `<alt>` is an alias for - * `<mod1>`. + * `` is an alias for ``, `` is an alias for + * ``, and `` is an alias for ``. * - * The action that is bound to the key is a sequence - * of signal names (strings) followed by parameters for - * each signal. The signals must be action signals. - * (See g_signal_new()). Each parameter can be - * a float, integer, string, or unquoted string - * representing an enumeration value. The types of - * the parameters specified must match the types of the - * parameters of the signal. + * The action that is bound to the key is a sequence of signal names + * (strings) followed by parameters for each signal. The signals must + * be action signals. (See g_signal_new()). Each parameter can be a + * float, integer, string, or unquoted string representing an enumeration + * value. The types of the parameters specified must match the types of + * the parameters of the signal. * * Binding sets are connected to widgets in the same manner as styles, * with one difference: Binding sets override other binding sets first diff --git a/gtk/deprecated/gtkrecentaction.c b/gtk/deprecated/gtkrecentaction.c index f61dfa98ff..d021e34da6 100644 --- a/gtk/deprecated/gtkrecentaction.c +++ b/gtk/deprecated/gtkrecentaction.c @@ -41,9 +41,9 @@ * #GtkRecentChooserMenu. * * To construct a submenu showing recently used files, use a #GtkRecentAction - * as the action for a <menuitem>. To construct a menu toolbutton showing + * as the action for a . To construct a menu toolbutton showing * the recently used files in the popup menu, use a #GtkRecentAction as the - * action for a <toolitem> element. + * action for a element. */ diff --git a/gtk/deprecated/gtkuimanager.c b/gtk/deprecated/gtkuimanager.c index 69f89e3270..9ae6c785d1 100644 --- a/gtk/deprecated/gtkuimanager.c +++ b/gtk/deprecated/gtkuimanager.c @@ -205,10 +205,10 @@ * * # Accelerators # * - * Every action has an accelerator path. Accelerators are installed together with - * menuitem proxies, but they can also be explicitly added with <accelerator> - * elements in the UI definition. This makes it possible to have accelerators for - * actions even if they have no visible proxies. + * Every action has an accelerator path. Accelerators are installed together + * with menuitem proxies, but they can also be explicitly added with + * elements in the UI definition. This makes it possible to + * have accelerators for actions even if they have no visible proxies. * * # Smart Separators # {#Smart-Separators} * @@ -240,10 +240,10 @@ * # GtkUIManager as GtkBuildable # {#GtkUIManager-BUILDER-UI} * * The GtkUIManager implementation of the GtkBuildable interface accepts - * GtkActionGroup objects as <child> elements in UI definitions. + * GtkActionGroup objects as elements in UI definitions. * * A GtkUIManager UI definition as described above can be embedded in - * an GtkUIManager <object> element in a GtkBuilder UI definition. + * an GtkUIManager element in a GtkBuilder UI definition. * * The widgets that are constructed by a GtkUIManager can be embedded in * other parts of the constructed user interface with the help of the @@ -1093,19 +1093,20 @@ gtk_ui_manager_get_accel_group (GtkUIManager *manager) * Looks up a widget by following a path. * The path consists of the names specified in the XML description of the UI. * separated by “/”. Elements which don’t have a name or action attribute in - * the XML (e.g. <popup>) can be addressed by their XML element name + * the XML (e.g. ) can be addressed by their XML element name * (e.g. "popup"). The root element ("/ui") can be omitted in the path. * - * Note that the widget found by following a path that ends in a <menu> - * element is the menuitem to which the menu is attached, not the menu itmanager. + * Note that the widget found by following a path that ends in a ; + * element is the menuitem to which the menu is attached, not the menu it + * manages. * * Also note that the widgets constructed by a ui manager are not tied to * the lifecycle of the ui manager. If you add the widgets returned by this * function to some container or explicitly ref them, they will survive the * destruction of the ui manager. * - * Return value: (transfer none): the widget found by following the path, or %NULL if no widget - * was found. + * Return value: (transfer none): the widget found by following the path, + * or %NULL if no widget was found * * Since: 2.4 * @@ -1932,9 +1933,9 @@ add_ui_from_string (GtkUIManager *manager, * @length: the length of @buffer (may be -1 if @buffer is nul-terminated) * @error: return location for an error * - * Parses a string containing a [UI definition][XML-UI] and - * merges it with the current contents of @manager. An enclosing <ui> - * element is added if it is missing. + * Parses a string containing a [UI definition][XML-UI] and merges it with + * the current contents of @manager. An enclosing element is added if + * it is missing. * * Return value: The merge id for the merged UI. The merge id can be used * to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, diff --git a/gtk/gtkaboutdialog.c b/gtk/gtkaboutdialog.c index 19b72777ee..e909503877 100644 --- a/gtk/gtkaboutdialog.c +++ b/gtk/gtkaboutdialog.c @@ -79,11 +79,11 @@ * use the function gtk_show_about_dialog() which constructs and shows a dialog * and keeps it around so that it can be shown again. * - * Note that GTK+ sets a default title of `_("About %s")` - * on the dialog window (where %s is replaced by the name of the - * application, but in order to ensure proper translation of the title, - * applications should set the title property explicitly when constructing - * a GtkAboutDialog, as shown in the following example: + * Note that GTK+ sets a default title of `_("About \%s")` on the dialog + * window (where \%s is replaced by the name of the application, but in + * order to ensure proper translation of the title, applications should + * set the title property explicitly when constructing a GtkAboutDialog, + * as shown in the following example: * |[ * gtk_show_about_dialog (NULL, * "program-name", "ExampleCode", diff --git a/gtk/gtkaccelgroup.c b/gtk/gtkaccelgroup.c index baa74b4340..7eaf8a9b47 100644 --- a/gtk/gtkaccelgroup.c +++ b/gtk/gtkaccelgroup.c @@ -1441,15 +1441,15 @@ out: * @accelerator_mods: (out) (allow-none): return location for accelerator * modifier mask, %NULL * - * Parses a string representing an accelerator. The - * format looks like “<Control>a” or “<Shift><Alt>F1” - * or “<Release>z” (the last one is for key release). + * Parses a string representing an accelerator. The format looks like + * “a” or “F1” or “z” (the last one is + * for key release). * - * The parser is fairly liberal and allows lower or upper case, - * and also abbreviations such as “<Ctl>” and “<Ctrl>”. - * Key names are parsed using gdk_keyval_from_name(). For character - * keys the name is not the symbol, but the lowercase name, e.g. one - * would use “<Ctrl>minus” instead of “<Ctrl>-”. + * The parser is fairly liberal and allows lower or upper case, and also + * abbreviations such as “” and “”. Key names are parsed using + * gdk_keyval_from_name(). For character keys the name is not the symbol, + * but the lowercase name, e.g. one would use “minus” instead of + * “-”. * * If the parse fails, @accelerator_key and @accelerator_mods will * be set to 0 (zero). @@ -1509,10 +1509,9 @@ gtk_accelerator_name_with_keycode (GdkDisplay *display, * @accelerator_key: accelerator keyval * @accelerator_mods: accelerator modifier mask * - * Converts an accelerator keyval and modifier mask - * into a string parseable by gtk_accelerator_parse(). - * For example, if you pass in #GDK_KEY_q and #GDK_CONTROL_MASK, - * this function returns “<Control>q”. + * Converts an accelerator keyval and modifier mask into a string + * parseable by gtk_accelerator_parse(). For example, if you pass in + * #GDK_KEY_q and #GDK_CONTROL_MASK, this function returns “q”. * * If you need to display accelerators in the user interface, * see gtk_accelerator_get_label(). diff --git a/gtk/gtkaccellabel.c b/gtk/gtkaccellabel.c index 71a53a2638..462aeac2e4 100644 --- a/gtk/gtkaccellabel.c +++ b/gtk/gtkaccellabel.c @@ -72,19 +72,21 @@ * GtkWidget *save_item; * GtkAccelGroup *accel_group; * - * /* Create a GtkAccelGroup and add it to the window. */ - * accel_group = gtk_accel_group_new (); + * /* Create a GtkAccelGroup and add it to the window. */ + * accel_group = gtk_accel_group_new (); * gtk_window_add_accel_group (GTK_WINDOW (window), accel_group); * - * /* Create the menu item using the convenience function. */ + * /* Create the menu item using the convenience function. */ * save_item = gtk_menu_item_new_with_label ("Save"); * gtk_widget_show (save_item); * gtk_container_add (GTK_CONTAINER (menu), save_item); * - * /* Now add the accelerator to the GtkMenuItem. Note that since we called - * gtk_menu_item_new_with_label() to create the GtkMenuItem the - * GtkAccelLabel is automatically set up to display the GtkMenuItem - * accelerators. We just need to make sure we use GTK_ACCEL_VISIBLE here. */ + * /* Now add the accelerator to the GtkMenuItem. Note that since we + * * called gtk_menu_item_new_with_label() to create the GtkMenuItem + * * the GtkAccelLabel is automatically set up to display the + * * GtkMenuItem accelerators. We just need to make sure we use + * * GTK_ACCEL_VISIBLE here. + * */ * gtk_widget_add_accelerator (save_item, "activate", accel_group, * GDK_KEY_s, GDK_CONTROL_MASK, GTK_ACCEL_VISIBLE); * ]| diff --git a/gtk/gtkaccelmap.c b/gtk/gtkaccelmap.c index de6d54a378..0cfef38992 100644 --- a/gtk/gtkaccelmap.c +++ b/gtk/gtkaccelmap.c @@ -54,7 +54,7 @@ * - accelerator modifiers * * The accelerator path must consist of - * “<WINDOWTYPE>/Category1/Category2/.../Action”, where WINDOWTYPE + * “/Category1/Category2/.../Action”, where WINDOWTYPE * should be a unique application-specific identifier that corresponds * to the kind of window the accelerator is being used in, e.g. * “Gimp-Image”, “Abiword-Document” or “Gnumeric-Settings”. @@ -62,7 +62,7 @@ * the action the accelerator triggers, i.e. for accelerators on menu * items, choose the item’s menu path, e.g. “File/Save As”, * “Image/View/Zoom” or “Edit/Select All”. So a full valid accelerator - * path may look like: “<Gimp-Toolbox>/File/Dialogs/Tool Options...”. + * path may look like: “/File/Dialogs/Tool Options...”. * * All accelerators are stored inside one global #GtkAccelMap that can * be obtained using gtk_accel_map_get(). See diff --git a/gtk/gtkapplication.c b/gtk/gtkapplication.c index 8fb80307ff..a40883b748 100644 --- a/gtk/gtkapplication.c +++ b/gtk/gtkapplication.c @@ -1073,9 +1073,8 @@ gtk_application_update_accels (GtkApplication *application) * to be activated when the key combination specificed by @accelerator * is pressed. * - * @accelerator must be a string that can be parsed by - * gtk_accelerator_parse(), e.g. "<Primary>q" or - * “<Control><Alt>p”. + * @accelerator must be a string that can be parsed by gtk_accelerator_parse(), + * e.g. "q" or “p”. * * @action_name must be the name of an action as it would be used * in the app menu, i.e. actions that have been added to the application diff --git a/gtk/gtkapplicationwindow.c b/gtk/gtkapplicationwindow.c index d7401217f1..67da6bede6 100644 --- a/gtk/gtkapplicationwindow.c +++ b/gtk/gtkapplicationwindow.c @@ -107,20 +107,17 @@ * [A simple example](https://git.gnome.org/browse/gtk+/tree/examples/sunny.c) * * The XML format understood by #GtkBuilder for #GMenuModel consists - * of a toplevel `<menu>` element, which contains - * one or more `<item>` elements. Each - * `<item>` element contains - * `<attribute>` and `<link>` - * elements with a mandatory name attribute. - * `<link>` elements have the same content - * model as `<menu>`. + * of a toplevel `` element, which contains one or more `` + * elements. Each `` element contains `` and `` + * elements with a mandatory name attribute. `` elements have the + * same content model as ``. * * Attribute values can be translated using gettext, like other #GtkBuilder - * content. `<attribute>` elements can be marked for - * translation with a `translatable="yes"` attribute. - * It is also possible to specify message context and translator comments, - * using the context and comments attributes. To make use of this, the - * #GtkBuilder must have been given the gettext domain to use. + * content. `` elements can be marked for translation with a + * `translatable="yes"` attribute. It is also possible to specify message + * context and translator comments,using the context and comments attributes. + * To make use of this, the #GtkBuilder must have been given the gettext + * domain to use. */ typedef GSimpleActionGroupClass GtkApplicationWindowActionsClass; diff --git a/gtk/gtkbindings.c b/gtk/gtkbindings.c index 18a17f52e0..1741bc1e30 100644 --- a/gtk/gtkbindings.c +++ b/gtk/gtkbindings.c @@ -104,15 +104,15 @@ * ]| * * The above example will not have the desired effect of causing - * “<Control>Right” and “<Control>Left” key presses to - * be ignored by GTK+. Instead, it just causes any existing bindings - * from the bindings set “MoveCursor3” to be deleted, so when - * “<Control>Right” or “<Control>Left” are pressed, no - * binding for these keys is found in binding set “MoveCursor3”. - * GTK+ will thus continue to search for matching key bindings, and - * will eventually lookup and find the default GTK+ bindings for - * entries which implement word movement. To keep GTK+ from activating - * its default bindings, the “unbind” keyword can be used like this: + * “Right” and “Left” key presses to be ignored by GTK+. + * Instead, it just causes any existing bindings from the bindings set + * “MoveCursor3” to be deleted, so when “Right” or + * “Left” are pressed, no binding for these keys is found in + * binding set “MoveCursor3”. GTK+ will thus continue to search for + * matching key bindings, and will eventually lookup and find the default + * GTK+ bindings for entries which implement word movement. To keep GTK+ + * from activating its default bindings, the “unbind” keyword can be used + * like this: * * |[ * @binding-set MoveCursor3 @@ -126,12 +126,11 @@ * } * ]| * - * Now, GTK+ will find a match when looking up “<Control>Right” - * and “<Control>Left” key presses before it resorts to its default - * bindings, and the match instructs it to abort (“unbind”) the search, - * so the key presses are not consumed by this widget. As usual, further - * processing of the key presses, e.g. by an entry’s parent widget, is - * now possible. + * Now, GTK+ will find a match when looking up “Right” and + * “Left” key presses before it resorts to its default bindings, + * and the match instructs it to abort (“unbind”) the search, so the key + * presses are not consumed by this widget. As usual, further processing + * of the key presses, e.g. by an entry’s parent widget, is now possible. */ /* --- defines --- */ diff --git a/gtk/gtkbuildable.c b/gtk/gtkbuildable.c index 6aff915ad6..d16e008c93 100644 --- a/gtk/gtkbuildable.c +++ b/gtk/gtkbuildable.c @@ -236,7 +236,7 @@ gtk_buildable_construct_child (GtkBuildable *buildable, * @data: (out): return location for user data that will be passed in * to parser functions * - * This is called for each unknown element under <child>. + * This is called for each unknown element under . * * Returns: %TRUE if a object has a custom implementation, %FALSE * if it doesn't. diff --git a/gtk/gtkbuilder.c b/gtk/gtkbuilder.c index ea5fd76057..3efe9e925d 100644 --- a/gtk/gtkbuilder.c +++ b/gtk/gtkbuilder.c @@ -71,33 +71,32 @@ * * [RELAX NG Compact Syntax](https://git.gnome.org/browse/gtk+/tree/gtk/gtkbuilder.rnc) * - * The toplevel element is <interface>. It optionally takes a - * “domain” attribute, which will make the builder look for translated - * strings using dgettext() in the domain specified. This can also be - * done by calling gtk_builder_set_translation_domain() on the builder. - * Objects are described by <object> elements, which can contain - * <property> elements to set properties, <signal> elements - * which connect signals to handlers, and <child> elements, which - * describe child objects (most often widgets inside a container, but - * also e.g. actions in an action group, or columns in a tree model). - * A <child> element contains an <object> element which - * describes the child object. The target toolkit version(s) are - * described by <requires> elements, the “lib” attribute specifies - * the widget library in question (currently the only supported value - * s “gtk+”) and the “version” attribute specifies the target version - * in the form “<major>.<minor>”. The builder will error + * The toplevel element is . It optionally takes a “domain” + * attribute, which will make the builder look for translated strings + * using dgettext() in the domain specified. This can also be done by + * calling gtk_builder_set_translation_domain() on the builder. + * Objects are described by elements, which can contain + * elements to set properties, elements which + * connect signals to handlers, and elements, which describe + * child objects (most often widgets inside a container, but also e.g. + * actions in an action group, or columns in a tree model). A + * element contains an element which describes the child object. + * The target toolkit version(s) are described by elements, + * the “lib” attribute specifies the widget library in question (currently + * the only supported value is “gtk+”) and the “version” attribute specifies + * the target version in the form “.”. The builder will error * out if the version requirements are not met. * - * Typically, the specific kind of object represented by an <object> - * element is specified by the “class” attribute. If the type has not been - * loaded yet, GTK+ tries to find the get_type() function from the - * class name by applying heuristics. This works in most cases, but - * if necessary, it is possible to specify the name of the - * get_type() function explictly with the "type-func" attribute. - * As a special case, GtkBuilder allows to use an object that has been - * constructed by a #GtkUIManager in another part of the UI definition - * by specifying the id of the #GtkUIManager in the “constructor” - * attribute and the name of the object in the “id” attribute. + * Typically, the specific kind of object represented by an + * element is specified by the “class” attribute. If the type has not + * been loaded yet, GTK+ tries to find the get_type() function from the + * class name by applying heuristics. This works in most cases, but if + * necessary, it is possible to specify the name of the get_type() function + * explictly with the "type-func" attribute. As a special case, GtkBuilder + * allows to use an object that has been constructed by a #GtkUIManager in + * another part of the UI definition by specifying the id of the #GtkUIManager + * in the “constructor” attribute and the name of the object in the “id” + * attribute. * * Objects may be given a name with the “id” attribute, which allows the * application to retrieve them from the builder with gtk_builder_get_object(). @@ -106,8 +105,8 @@ * with ___ (3 underscores) for its own purposes. * * Setting properties of objects is pretty straightforward with the - * <property> element: the “name” attribute specifies the name - * of the property, and the content of the element specifies the value. + * element: the “name” attribute specifies the name of the + * property, and the content of the element specifies the value. * If the “translatable” attribute is set to a true value, GTK+ uses * gettext() (or dgettext() if the builder has a translation domain set) * to find a translation for the value. This happens before the value @@ -135,11 +134,11 @@ * object has to be constructed before it can be used as the value of * a construct-only property. * - * Signal handlers are set up with the <signal> element. The - * “name” attribute specifies the name of the signal, and the “handler” - * attribute specifies the function to connect to the signal. By default, - * GTK+ tries to find the handler using g_module_symbol(), but this can - * be changed by passing a custom #GtkBuilderConnectFunc to + * Signal handlers are set up with the element. The “name” + * attribute specifies the name of the signal, and the “handler” attribute + * specifies the function to connect to the signal. By default, GTK+ tries + * to find the handler using g_module_symbol(), but this can be changed by + * passing a custom #GtkBuilderConnectFunc to * gtk_builder_connect_signals_full(). The remaining attributes, “after”, * “swapped” and “object”, have the same meaning as the corresponding * parameters of the g_signal_connect_object() or @@ -151,13 +150,13 @@ * been constructed by GTK+ as part of a composite widget, to set * properties on them or to add further children (e.g. the @vbox of * a #GtkDialog). This can be achieved by setting the “internal-child” - * propery of the <child> element to a true value. Note that - * GtkBuilder still requires an <object> element for the internal - * child, even if it has already been constructed. + * propery of the element to a true value. Note that GtkBuilder + * still requires an element for the internal child, even if it + * has already been constructed. * * A number of widgets have different places where a child can be added * (e.g. tabs vs. page content in notebooks). This can be reflected in - * a UI definition by specifying the “type” attribute on a <child>. + * a UI definition by specifying the “type” attribute on a * The possible values for the “type” attribute are described in the * sections describing the widget-specific portions of UI definitions. * @@ -189,16 +188,15 @@ * * Beyond this general structure, several object classes define their * own XML DTD fragments for filling in the ANY placeholders in the DTD - * above. Note that a custom element in a <child> element gets - * parsed by the custom tag handler of the parent object, while a custom - * element in an <object> element gets parsed by the custom tag - * handler of the object. + * above. Note that a custom element in a element gets parsed by + * the custom tag handler of the parent object, while a custom element in + * an element gets parsed by the custom tag handler of the object. * * These XML fragments are explained in the documentation of the * respective objects. * - * Additionally, since 3.10 a special <template> tag has been - * added to the format allowing one to define a widget class’s components. + * Additionally, since 3.10 a special